resourceType | PractitionerRole | 0..* | "Practitioner" | All DHBs | Fixed Value |
id | string | 0..1 | "44446" | All DHBs | For ADHB, this contains the Practitioner unique identifier. For CMH, NDHB and WDHB, this is the same value as Practitioner.identifier.value, which contains the HPI-CPN. |
meta | Meta | 0..1 | | All DHBs | |
````meta.versionId | id | 0..1 | "0.4.5" | All DHBs | Indicates the Patient IG version number. |
````meta.lastUpdated | instant | 0..1 | | All DHBs | The version of the patient record in PAS is not kept. Source data is also derived from several tables in source. So, timestamp may be different per table. |
````meta.source | uri | 0..1 | "CMS" | All DHBs | "Identifies the PAS system where information was drawn from. Value is "CMS" for ADHB, "WebPAS" for NDHB and "iPM" for CMH and WDHB." |
````meta.profile | canonical(Structure Definition) | 0..* | (see comments) | All DHBs | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/NorthernRegionPatient |
````meta.security.code | code | 0..1 | "N" | All DHBs | Fixed Value |
````meta.security.display | string | 0..1 | "Normal" | All DHBs | Fixed Value |
identifier[i] | Identifier | 0..* | | All DHBs | |
````identifier: HPI | Identifier | 0..1 | | All DHBs | |
````````identifier.use | code | 1..1 | "official" | All DHBs | Fixed Value |
````````identifier.type | CodeableConcept | 0..1 | | All DHBs | |
````````````identifier.type.coding.system | uri | 0..1 | (see comments) | All DHBs | Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
````````````identifier.type.code | code | 0..1 | "HPI_CPN" | All DHBs | Fixed Value |
````````````identifier.type.display | string | 0..1 | "HPI_CPN" | All DHBs | Fixed Value |
```````````identifier.type.text | string | 0..1 | "HPI_CPN" | All DHBs | Fixed Value |
````````identifier.system | uri | 0..1 | (see comments) | All DHBs | Fixed Value: https://standards.digital.health.nz/ns/hpi-person-id |
````````identifier value | string | 0..1 | "10AWSK" | All DHBs | For CMH, NDHB and WDHB, this is the same value as Practitioner.id. |
````identifier: dormantHPI | Identifier | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
name[i] | HumanName | 1..* | | All DHBs | |
````preferred name | Extension: Boolean | 0..* | | ADHB | Preferred name of the general practitioner. |
````````preferred name.url | uri | 1..1 | (see comments) | ADHB | Fixed Value: http://hl7.org/fhir/StructureDefinition/iso21090-preferred |
````````preferred name.value | boolean | 0..1 | true | ADHB | Possible values are true or false |
````name.use | code | 0..1 | "official" | All DHBs | "For CMH, NDHB and WDBH, this field is always set to "usual". ADHB can have both official name and preferred name of the practitioner. ADHB practitioner preferred name will always have "usual" as the name.use value." |
````name.text | string | 0..1 | "Dr Benjamin Mark Comery" | All DHBs | This is a concatenation of practitioner name prefix (title), give names and family name. |
````name.family | string | 0..1 | "Comery" | All DHBs | Contains the surname of the practitioner. |
````name.given[x] | string | 0..* | "Benjamin Mark" | All DHBs | For ADHB, WDHB and CMH, a practitioner can have up to 3 given names. For NDHB, only one practitioner given name is provided. |
````name.prefix[x] | string | 0..* | "Dr" | All DHBs | Contains the title of the practitioner. |
gender | code | 1..1 | "unknown" | CMH, NDHB, WDHB | "Possible values are "female", "male", "unknown". "other" is presently not used. Practitioner gender is not available in ADHB." |
qualification[i] | BackboneElement | 0..* | | All DHBs | Certification, licenses, or training pertaining to the provision of care |
````qualification.id | CodeableConcept | 1..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
````qualification.registration-status-code | CodeableConcept | 1..1 | | n/a | An indicator of the practicing status of the practitioner as supplied by their Responsible Authority or professional body. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````registration-status-code.status | | | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````registration-status-code.status.system | uri | 0..1 | (see comments) | n/a | Fixed Value: https://standards.digital.health.nz/ns/practitioner-registration-status-code. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````registration-status-code.status.code | code | 0..1 | "MD" | n/a | Fixed Value. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````registration-status-code.status.display | string | 0..1 | "Medical License number" | n/a | Fixed Value. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````registration-status-code.status.text | string | 0..1 | "Medical License number" | n/a | Fixed Value. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````qualification.registration-period | CodeableConcept | 1..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````qualification.registration-period.url | uri | 1..1 | "period" | n/a | Fixed Value. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````qualification.registration-period.value.start | dateTime | | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````qualification.registration-period.value.end | dateTime | 0..1 | | n/a | Expiry date of the Medical License Number. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````qualification.registration-status-code.url | uri | 1..1 | (see comments) | n/a | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/registration-status-code |
````qualification.scope_of_practice | Complex | 1..1 | | NDHB | The type or range of health services a practitioner is authorised to perform, as determined by the Responsible Authority or professional body. |
````````qualification.scope_of_practice.code | | | | NDHB | |
````````````scope_of_practice.code.url | uri | 1..1 | "code" | NDHB | Fixed Value |
````````````scope_of_practice.code.system | uri | 0..1 | (see comments) | NDHB | Fixed Value: https://standards.digital.health.nz/ns/practitioner-scope-of-practice |
````````````scope_of_practice.code.code | code | 0..1 | "GP" | NDHB | |
````````````scope_of_practice.code.display | string | 0..1 | "General Practice" | NDHB | |
````````````scope_of_practice.code.text | string | 0..1 | "General Practice" | NDHB | Same as display value. |
````````qualification.scope_of_practice.period | CodeableConcept | 1..1 | | NDHB | |
````````````scope_of_practice.period.url | uri | 1..1 | "period" | NDHB | Fixed Value |
````````````scope_of_practice.period.value.start | dateTime | | | NDHB | |
````````````scope_of_practice.period.value.end | dateTime | 0..1 | | NDHB | not used |
````````qualification.scope_of_practice.url | uri | 1..1 | (see comments) | NDHB | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice |
````qualification.condition_on_practice | Complex | 1..1 | | n/a | A full description of the conditions the health practitioner is subject to in relation to their scope of practice. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````qualification.condition_on_practice.code | | | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````scope_of_practice.period.url | uri | 1..1 | "description" | n/a | Fixed Value. This is a placeholder element and presently not used by any of the 4 DHBs. |
````````````condition_on_practice.code.value | string | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
````````qualification.condition_on_practice.period | CodeableConcept | 1..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
````````qualification.condition_on_practice.url | uri | 1..1 | (see comments) | n/a | Fixed Value: http://hl7.org.nz/fhir/StructureDefinition/scope-of-practice |
````qualification.identifier[i]: Registration | Identifier | 0..* | | All DHBs | |
````````qualification.identifier.use | code | 1..1 | "official" | All DHBs | Fixed Value |
````````qualification.identifier.type | CodeableConcept | 0..1 | | All DHBs | |
````````````qualification.identifier.type.coding.system | uri | 0..1 | (see comments) | All DHBs | Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 |
````````````qualification.identifier.type.code | code | 0..1 | "MD" | All DHBs | |
````````````qualification.identifier.type.display | string | 0..1 | "Medical License number" | All DHBs | |
```````````qualification.identifier.type.text | string | 0..1 | "Medical License number" | All DHBs | |
````````qualification.identifier.system | uri | 0..1 | (see comments) | All DHBs | Fixed Value: https://standards.digital.health.nz/ns/medical-council-id |
````````qualification.identifier value | string | 0..1 | "78864" | All DHBs | "If qualification.code.code is "MC" then the 5-digit value is a medical council number. For For CMH, NDHB and WDHB, if qualification.code.code is "NC", then the 6-digit value is a nursing council number." |
````qualification.code | | | | All DHBs | |
````````qualification.code.system | uri | 0..1 | (see comments) | All DHBs | Fixed Value: https://standards.digital.health.nz/id/hpi-organisation |
````````qualification.code.code | code | 0..1 | "NC" | All DHBs | "For CMH, NDHB and WDHB, value can be null, "MC" or "NC"." |
````````qualification.code.display | string | 0..1 | "Nurse Council Number" | All DHBs | "For CMH, NDHB and WDHB, display can be null, "Medical Council Number" or "Nurse Council Number"." |
````````qualification.code.text | string | 0..1 | "Nurse Council Number" | All DHBs | Same as display value. |
````qualification.issuer | | 0..1 | | All DHBs | |
````````qualification.issuer.reference | Reference {Organization} | 0..1 | "Organisation/NC" | All DHBs | "This is a string field that concatenates "Organisation/" and qualification.code.code." |
````````qualification.issuer.identifier | string | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
```````qualification.issuer.identifier.text | string | 0..1 | | n/a | This is a placeholder element and presently not used by any of the 4 DHBs. |
communication[i] | BackboneElement | 0..* | | All DHBs | A language the practitioner can use in patient communication |
````communication.language | CodeableConcept | 1..1 | | All DHBs | |
````````communication.language.system | uri | 0..1 | urn:ietf:bcp:47 | All DHBs | Fixed Value |
````````communication.language.code | code | 0..1 | "11" | All DHBs | "ADHB and NDHB uses numeric codes while CMH and WDHB are using alpha codes, example "FIJIAN"." |
````````communication.language.display | string | 0..1 | "Chinese - Teochoew" | All DHBs | |
````````communication.language.text | string | 0..1 | "Chinese - Teochoew" | All DHBs | Same as display value. |